/*
 * Copyright (C) 2021 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.sentry.transport;

import io.sentry.SentryEnvelope;

import java.io.Closeable;
import java.io.IOException;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * A transport is in charge of sending the event to the Sentry server.
 *
 * @since 2021-06-02
 */
public interface ITransport extends Closeable {
    /**
     * send SentryEnvelope
     *
     * @param envelope SentryEnvelope
     * @param hint Object
     * @throws IOException exception
     */
    void send(@NotNull SentryEnvelope envelope, @Nullable Object hint) throws IOException;

    /**
     * send SentryEnvelope
     *
     * @param envelope SentryEnvelope
     * @throws IOException exception
     */
    default void send(@NotNull SentryEnvelope envelope) throws IOException {
        send(envelope, null);
    }

    /**
     * Flushes events queued up, but keeps the client enabled. Not implemented yet.
     *
     * @param timeoutMillis time in milliseconds
     */
    void flush(long timeoutMillis);
}
